API Documentation
MAIN PAGE
NAMESPACES
CLASSES
Documentation
Headers
NilkinsAstraeus
Graphics
Effects
Ssao
SsaoEffect.h
1
// SsaoEffect.h
3
//
5
6
namespace
nkAstraeus
7
{
17
class
SsaoEffect
final :
public
Effect
18
{
19
public :
20
25
SsaoEffect
() ;
29
~SsaoEffect
() ;
30
31
// Getters
35
virtual
EFFECT_TYPE
getType
()
const override
;
39
nkGraphics::Texture
*
getPositionBuffer
()
const
;
43
nkGraphics::Texture
*
getNormalBuffer
()
const
;
47
nkGraphics::Texture
*
getDepthBuffer
()
const
;
51
float
getSamplingRadius
()
const
;
55
float
getMaxOcclusionDistance
()
const
;
59
float
getStrength
()
const
;
63
float
getDepthBias
()
const
;
67
unsigned
int
getKernelSampleCount
()
const
;
71
bool
getOcclusionDrivesAlpha
()
const
;
72
73
// Setters
94
void
setEffectFromGBufferInfo
(
nkGraphics::Texture
* positionBuffer,
nkGraphics::Texture
* normalBuffer =
nullptr
) ;
112
void
setEffectFromDepthInfo
(
nkGraphics::Texture
* depthBuffer) ;
124
void
setSamplingRadius
(
float
value) ;
136
void
setMaxOcclusionDistance
(
float
value) ;
147
void
setStrength
(
float
value) ;
158
void
setDepthBias
(
float
value) ;
170
void
setKernelSampleCount
(
unsigned
int
value) ;
184
void
setOcclusionDrivesAlpha
(
bool
value) ;
185
186
// Load
190
virtual
bool
load
()
override
;
194
virtual
void
unload
()
override
;
195
} ;
196
}
nkAstraeus::SsaoEffect::setEffectFromDepthInfo
void setEffectFromDepthInfo(nkGraphics::Texture *depthBuffer)
nkAstraeus::SsaoEffect::setDepthBias
void setDepthBias(float value)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition:
Texture.h:35
nkAstraeus::EFFECT_TYPE
EFFECT_TYPE
Lists all effects supported.
Definition:
EffectType.h:12
nkAstraeus::SsaoEffect::getDepthBias
float getDepthBias() const
nkAstraeus::SsaoEffect::getStrength
float getStrength() const
nkAstraeus::SsaoEffect::getDepthBuffer
nkGraphics::Texture * getDepthBuffer() const
nkAstraeus::SsaoEffect::load
virtual bool load() override
nkAstraeus::SsaoEffect::getPositionBuffer
nkGraphics::Texture * getPositionBuffer() const
nkAstraeus::SsaoEffect::unload
virtual void unload() override
nkAstraeus::SsaoEffect::getKernelSampleCount
unsigned int getKernelSampleCount() const
nkAstraeus::SsaoEffect::getSamplingRadius
float getSamplingRadius() const
nkAstraeus::SsaoEffect
A Screen Space Ambient Occlusion effect.
Definition:
SsaoEffect.h:18
nkAstraeus::SsaoEffect::setOcclusionDrivesAlpha
void setOcclusionDrivesAlpha(bool value)
nkAstraeus::SsaoEffect::getType
virtual EFFECT_TYPE getType() const override
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition:
Engine.h:7
nkAstraeus::Effect
Base class for all effects in the component.
Definition:
Effect.h:16
nkAstraeus::SsaoEffect::getNormalBuffer
nkGraphics::Texture * getNormalBuffer() const
nkAstraeus::SsaoEffect::setSamplingRadius
void setSamplingRadius(float value)
nkAstraeus::SsaoEffect::setKernelSampleCount
void setKernelSampleCount(unsigned int value)
nkAstraeus::SsaoEffect::setEffectFromGBufferInfo
void setEffectFromGBufferInfo(nkGraphics::Texture *positionBuffer, nkGraphics::Texture *normalBuffer=nullptr)
nkAstraeus::SsaoEffect::getOcclusionDrivesAlpha
bool getOcclusionDrivesAlpha() const
nkAstraeus::SsaoEffect::setMaxOcclusionDistance
void setMaxOcclusionDistance(float value)
nkAstraeus::SsaoEffect::getMaxOcclusionDistance
float getMaxOcclusionDistance() const
nkAstraeus::SsaoEffect::setStrength
void setStrength(float value)
nkAstraeus::SsaoEffect::~SsaoEffect
~SsaoEffect()
nkAstraeus::SsaoEffect::SsaoEffect
SsaoEffect()
Generated by
Doxygen
1.8.18